Caching in inheritance accessor functions #510
Conversation
mldwg
changed the title
bckohan
force-pushed
the
related_accessor
branch
from
705acf4 to
5945de6
Compare
There was a problem hiding this comment.
Pull request overview
This pull request adds caching to inheritance accessor functions in PolymorphicModel to align with Django's default behavior and avoid redundant database queries. Previously, the overridden accessor functions would execute a new database query on each access, which contradicts Django's standard caching behavior for related objects.
Key changes:
- Modified accessor functions to use Django's field caching via
get_cached_value()andset_cached_value() - Added comprehensive test coverage for both forward and reverse accessors
- Ensured cache is properly cleared by
refresh_from_db()
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| src/polymorphic/models.py | Updated create_accessor_function_for_model to implement caching using Django's field caching mechanism, extracting the field object from descriptors to access cache methods |
| src/polymorphic/tests/test_orm.py | Added test_polymorphic__accessor_caching to verify that inheritance accessors return cached objects on repeated access and that cache is cleared after refresh_from_db() |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #510 +/- ##
=======================================
Coverage 75.53% 75.53%
=======================================
Files 21 21
Lines 1345 1345
Branches 213 213
=======================================
Hits 1016 1016
Misses 257 257
Partials 72 72 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Co-authored-by: otto001 <matteo.ludwig@gmail.com> Co-authored-by: Brian Kohan <bckohan@gmail.com>
bckohan
force-pushed
the
related_accessor
branch
from
1f56f9e to
4993752
Compare
bckohan
left a comment
bckohan
left a comment
There was a problem hiding this comment.
Thanks for this, sorry it took so long to merge - this project was leaderless for a number of years. Great test!
2 participants
The accessor functions for inheritance relations are overwritten in PolymorphicModel. This also disables the caching usually provided by django, creating multiple redundant SQL queries in certain situations:
This contradicts the default django behavior and can cause unnecessary overhead.
This PR fixes that issue by using the caching mechanism of the underlying field.
The new unit test
test_polymorphic__accessor_cachingvalidates this new feature.